[Doc] Add assets needed for new docs build system#7
Merged
peytondmurray merged 1 commit intodocs-build-system-upgradefrom Nov 16, 2023
Merged
Conversation
Signed-off-by: pdmurray <peynmurray@gmail.com>
maxpumperla
approved these changes
Nov 15, 2023
maxpumperla
left a comment
There was a problem hiding this comment.
Great, I really like this one. Also, good decision on kicking Algolia for now. Very pragmatic approach, as we had issues with the system anyway.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
This PR adds/modifies/removes assets and templates for the new build system.
LandingPageBG.jpg, which wasn't being correctly loaded in theindex.htmlpage, and which doesn't work well on dark theme anywaycustom.cssto include only the side-wide CSS rules we need - this was done line-by-line, so a lot of unnecessary rules have been removed, mostly because don't apply to the new pages anymore, or they don't make sense to do with the updated theme. Note that theray-blueCSS variable is stored globally here!custom.js:docsearch.jshas been removed. We have builtin search now; if we don't like it, we can replace it later on.top-navigation.jshas been removed; the top bar is rendered with a template at build time rather than with a script.breadcrumbs.htmlhas been removed, I don't think it was being used.pydata-sphinx-themehas a breadcrumbs widget builtin.hljshas been updated to11.9.0.footer-content.html, so this is no longer needed.sbt-sidebar-nav.htmlis no longer needed. Also, we're not using sphinx book theme anymore.Related issue number
Partially addresses ray-project#37944.
Depends on #2.
PR 6/x targeting ray-project#41115.
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.